<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: sc2::ProtoInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>sc2</b></li><li class="navelem"><a class="el" href="classsc2_1_1_proto_interface.html">ProtoInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsc2_1_1_proto_interface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">sc2::ProtoInterface Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5bc1f68b90e3092b0a5ddf7c64a3c447"><td class="memItemLeft" align="right" valign="top"><a id="a5bc1f68b90e3092b0a5ddf7c64a3c447"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ConnectToGame</b> (const std::string &amp;address, int port, int timeout_ms)</td></tr>
<tr class="separator:a5bc1f68b90e3092b0a5ddf7c64a3c447"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f422cd831ab9518ee0e5c4bc291d225"><td class="memItemLeft" align="right" valign="top"><a id="a9f422cd831ab9518ee0e5c4bc291d225"></a>
GameRequestPtr&#160;</td><td class="memItemRight" valign="bottom"><b>MakeRequest</b> ()</td></tr>
<tr class="separator:a9f422cd831ab9518ee0e5c4bc291d225"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a102c3b51d445df0aa9439f0dc75039bc"><td class="memItemLeft" align="right" valign="top"><a id="a102c3b51d445df0aa9439f0dc75039bc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>SendRequest</b> (GameRequestPtr &amp;request, bool ignore_pending_requests=false)</td></tr>
<tr class="separator:a102c3b51d445df0aa9439f0dc75039bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b1bb2eb7b513dd3703d35369a67a57b"><td class="memItemLeft" align="right" valign="top"><a id="a5b1bb2eb7b513dd3703d35369a67a57b"></a>
GameResponsePtr&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForResponseInternal</b> ()</td></tr>
<tr class="separator:a5b1bb2eb7b513dd3703d35369a67a57b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a242d03e9673ac394386f28223e41fec8"><td class="memItemLeft" align="right" valign="top"><a id="a242d03e9673ac394386f28223e41fec8"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>PingGame</b> ()</td></tr>
<tr class="separator:a242d03e9673ac394386f28223e41fec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92160bb840119a0bd033eb21ff2ad445"><td class="memItemLeft" align="right" valign="top"><a id="a92160bb840119a0bd033eb21ff2ad445"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Quit</b> ()</td></tr>
<tr class="separator:a92160bb840119a0bd033eb21ff2ad445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c33f48c9ef0a00f853b9f750a872a2"><td class="memItemLeft" align="right" valign="top"><a id="a03c33f48c9ef0a00f853b9f750a872a2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetErrorCallback</b> (std::function&lt; void(const std::string &amp;error_str)&gt; error_callback)</td></tr>
<tr class="separator:a03c33f48c9ef0a00f853b9f750a872a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b6cbc303c53a5b63278f4d56a85e301"><td class="memItemLeft" align="right" valign="top"><a id="a6b6cbc303c53a5b63278f4d56a85e301"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>PollResponse</b> ()</td></tr>
<tr class="separator:a6b6cbc303c53a5b63278f4d56a85e301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe3b76cf6a174189f41e81718c9c0bf"><td class="memItemLeft" align="right" valign="top"><a id="a4fe3b76cf6a174189f41e81718c9c0bf"></a>
SC2APIProtocol::Status&#160;</td><td class="memItemRight" valign="bottom"><b>GetLastStatus</b> () const</td></tr>
<tr class="separator:a4fe3b76cf6a174189f41e81718c9c0bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3480b4687b57ea0feea2bb158cc56c13"><td class="memItemLeft" align="right" valign="top"><a id="a3480b4687b57ea0feea2bb158cc56c13"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>HasResponsePending</b> () const</td></tr>
<tr class="separator:a3480b4687b57ea0feea2bb158cc56c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a398e9c12408ee8bc45b3fc7c9849fa31"><td class="memItemLeft" align="right" valign="top"><a id="a398e9c12408ee8bc45b3fc7c9849fa31"></a>
SC2APIProtocol::Response::ResponseCase&#160;</td><td class="memItemRight" valign="bottom"><b>GetResponsePending</b> () const</td></tr>
<tr class="separator:a398e9c12408ee8bc45b3fc7c9849fa31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a245d66808a9d6ac07eaa167c696ef8ac"><td class="memItemLeft" align="right" valign="top"><a id="a245d66808a9d6ac07eaa167c696ef8ac"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetAssignedPort</b> () const</td></tr>
<tr class="separator:a245d66808a9d6ac07eaa167c696ef8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3133ff62318eaf7109c161b21bab4174"><td class="memItemLeft" align="right" valign="top"><a id="a3133ff62318eaf7109c161b21bab4174"></a>
const std::vector&lt; uint32_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetStats</b> () const</td></tr>
<tr class="separator:a3133ff62318eaf7109c161b21bab4174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f19f76c2c0c212841b934a151ac43b9"><td class="memItemLeft" align="right" valign="top"><a id="a5f19f76c2c0c212841b934a151ac43b9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetControl</b> (<a class="el" href="classsc2_1_1_control_interface.html">ControlInterface</a> *control)</td></tr>
<tr class="separator:a5f19f76c2c0c212841b934a151ac43b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2295d11818a07258c87c4d94af8fa364"><td class="memItemLeft" align="right" valign="top"><a id="a2295d11818a07258c87c4d94af8fa364"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetBaseBuild</b> () const</td></tr>
<tr class="separator:a2295d11818a07258c87c4d94af8fa364"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f3ee8353ae1ff9db5cb06f83796f854"><td class="memItemLeft" align="right" valign="top"><a id="a2f3ee8353ae1ff9db5cb06f83796f854"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetDataVersion</b> () const</td></tr>
<tr class="separator:a2f3ee8353ae1ff9db5cb06f83796f854"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a8fdac4b0429cbf86ec7c1edba4e326fc"><td class="memItemLeft" align="right" valign="top"><a id="a8fdac4b0429cbf86ec7c1edba4e326fc"></a>
<a class="el" href="classsc2_1_1_connection.html">Connection</a>&#160;</td><td class="memItemRight" valign="bottom"><b>connection_</b></td></tr>
<tr class="separator:a8fdac4b0429cbf86ec7c1edba4e326fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d79099fa89d4bcc0bb001d27d7a801e"><td class="memItemLeft" align="right" valign="top"><a id="a4d79099fa89d4bcc0bb001d27d7a801e"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>address_</b></td></tr>
<tr class="separator:a4d79099fa89d4bcc0bb001d27d7a801e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15e1f66ed2cd1c0808f9bf500b81d0e6"><td class="memItemLeft" align="right" valign="top"><a id="a15e1f66ed2cd1c0808f9bf500b81d0e6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>port_</b></td></tr>
<tr class="separator:a15e1f66ed2cd1c0808f9bf500b81d0e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84700c40de82de13b594ed1efb22a214"><td class="memItemLeft" align="right" valign="top"><a id="a84700c40de82de13b594ed1efb22a214"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>default_timeout_ms_</b></td></tr>
<tr class="separator:a84700c40de82de13b594ed1efb22a214"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13b6b03fa93720ba9c5f35791d4d8d45"><td class="memItemLeft" align="right" valign="top"><a id="a13b6b03fa93720ba9c5f35791d4d8d45"></a>
std::function&lt; void(const std::string &amp;error_str)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>error_callback_</b></td></tr>
<tr class="separator:a13b6b03fa93720ba9c5f35791d4d8d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ca4c71c316152c099be11ba27eb27a"><td class="memItemLeft" align="right" valign="top"><a id="a01ca4c71c316152c099be11ba27eb27a"></a>
SC2APIProtocol::Status&#160;</td><td class="memItemRight" valign="bottom"><b>latest_status_</b></td></tr>
<tr class="separator:a01ca4c71c316152c099be11ba27eb27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ce86c185be3b759be60f99d0fd933e1"><td class="memItemLeft" align="right" valign="top"><a id="a7ce86c185be3b759be60f99d0fd933e1"></a>
SC2APIProtocol::Response::ResponseCase&#160;</td><td class="memItemRight" valign="bottom"><b>response_pending_</b></td></tr>
<tr class="separator:a7ce86c185be3b759be60f99d0fd933e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13bdf9947b97df63442346b2f50e2391"><td class="memItemLeft" align="right" valign="top"><a id="a13bdf9947b97df63442346b2f50e2391"></a>
std::vector&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>count_uses_</b></td></tr>
<tr class="separator:a13bdf9947b97df63442346b2f50e2391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7927936b004d254fba365487a1f0dcd9"><td class="memItemLeft" align="right" valign="top"><a id="a7927936b004d254fba365487a1f0dcd9"></a>
<a class="el" href="classsc2_1_1_control_interface.html">ControlInterface</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>control_</b></td></tr>
<tr class="separator:a7927936b004d254fba365487a1f0dcd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2c505d2b3019b09e78180af425d5aa0"><td class="memItemLeft" align="right" valign="top"><a id="aa2c505d2b3019b09e78180af425d5aa0"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>base_build_</b></td></tr>
<tr class="separator:aa2c505d2b3019b09e78180af425d5aa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade08078ef981ae448ca0851714b23f3a"><td class="memItemLeft" align="right" valign="top"><a id="ade08078ef981ae448ca0851714b23f3a"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>data_version_</b></td></tr>
<tr class="separator:ade08078ef981ae448ca0851714b23f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/sc2api/<a class="el" href="sc2__proto__interface_8h_source.html">sc2_proto_interface.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
